home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / checkbutton.n < prev    next >
Text File  |  1994-09-20  |  15KB  |  480 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/checkbutton.n,v 1.22 93/04/01 09:52:35 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS checkbutton tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. checkbutton \- Create and manipulate check-button widgets
  210. .SH SYNOPSIS
  211. \fBcheckbutton\fI pathName \fR?\fIoptions\fR?
  212. .SH "STANDARD OPTIONS"
  213. .LP
  214. .nf
  215. .ta 4c 8c 12c
  216. .VS
  217. \fBactiveBackground\fR    \fBbitmap\fR    \fBfont\fR    \fBrelief\fR
  218. \fBactiveForeground\fR    \fBborderWidth\fR    \fBforeground\fR    \fBtext\fR
  219. \fBanchor\fR    \fBcursor\fR    \fBpadX\fR    \fBtextVariable\fR
  220. \fBbackground\fR    \fBdisabledForeground\fR    \fBpadY\fR
  221. .VE
  222. .fi
  223. .LP
  224. See the ``options'' manual entry for details on the standard options.
  225. .SH "WIDGET-SPECIFIC OPTIONS"
  226. .ta 4c
  227. .LP
  228. .nf
  229. Name:    \fBcommand\fR
  230. Class:    \fBCommand\fR
  231. Command-Line Switch:    \fB\-command\fR
  232. .fi
  233. .IP
  234. Specifies a Tcl command to associate with the button.  This command
  235. is typically invoked when mouse button 1 is released over the button
  236. window.  The button's global variable (\fB\-variable\fR option) will
  237. be updated before the command is invoked.
  238. .LP
  239. .nf
  240. .VS
  241. Name:    \fBheight\fR
  242. Class:    \fBHeight\fR
  243. Command-Line Switch:    \fB\-height\fR
  244. .fi
  245. .IP
  246. Specifies a desired height for the button.
  247. If a bitmap is being displayed in the button then the value is in
  248. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  249. for text it is in lines of text.
  250. If this option isn't specified, the button's desired height is computed
  251. from the size of the bitmap or text being displayed in it.
  252. .VE
  253. .LP
  254. .nf
  255. Name:    \fBoffValue\fR
  256. Class:    \fBValue\fR
  257. Command-Line Switch:    \fB\-offvalue\fR
  258. .fi
  259. .IP
  260. Specifies value to store in the button's associated variable whenever
  261. this button is deselected.  Defaults to ``0''.
  262. .LP
  263. .nf
  264. Name:    \fBonValue\fR
  265. Class:    \fBValue\fR
  266. Command-Line Switch:    \fB\-onvalue\fR
  267. .fi
  268. .IP
  269. Specifies value to store in the button's associated variable whenever
  270. this button is selected.  Defaults to ``1''.
  271. .LP
  272. .nf
  273. Name:    \fBselector\fR
  274. Class:    \fBForeground\fR
  275. Command-Line Switch:    \fB\-selector\fR
  276. .fi
  277. .IP
  278. Specifies the color to draw in the selector when this button is
  279. selected.
  280. .VS
  281. If specified as an empty string then no selector is
  282. drawn for the button.
  283. .LP
  284. .nf
  285. Name:    \fBstate\fR
  286. Class:    \fBState\fR
  287. Command-Line Switch:    \fB\-state\fR
  288. .fi
  289. .IP
  290. Specifies one of three states for the check button:  \fBnormal\fR, \fBactive\fR,
  291. or \fBdisabled\fR.  In normal state the check button is displayed using the
  292. \fBforeground\fR and \fBbackground\fR options.  The active state is
  293. typically used when the pointer is over the check button.  In active state
  294. the check button is displayed using the \fBactiveForeground\fR and
  295. \fBactiveBackground\fR options.  Disabled state means that the check button
  296. is insensitive:  it doesn't activate and doesn't respond to mouse
  297. button presses.  In this state the \fBdisabledForeground\fR and
  298. \fBbackground\fR options determine how the check button is displayed.
  299. .VE
  300. .LP
  301. .nf
  302. Name:    \fBvariable\fR
  303. Class:    \fBVariable\fR
  304. Command-Line Switch:    \fB\-variable\fR
  305. .fi
  306. .IP
  307. Specifies name of global variable to set to indicate whether
  308. or not this button is selected.  Defaults to the name of the
  309. button within its parent (i.e. the last element of the button
  310. window's path name).
  311. .LP
  312. .nf
  313. .VS
  314. Name:    \fBwidth\fR
  315. Class:    \fBWidth\fR
  316. Command-Line Switch:    \fB\-width\fR
  317. .fi
  318. .IP
  319. Specifies a desired width for the button.
  320. If a bitmap is being displayed in the button then the value is in
  321. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  322. for text it is in characters.
  323. If this option isn't specified, the button's desired width is computed
  324. from the size of the bitmap or text being displayed in it.
  325. .VE
  326. .BE
  327.  
  328. .SH DESCRIPTION
  329. .PP
  330. The \fBcheckbutton\fR command creates a new window (given by the
  331. \fIpathName\fR argument) and makes it into a check-button widget.
  332. Additional
  333. options, described above, may be specified on the command line
  334. or in the option database
  335. to configure aspects of the check button such as its colors, font,
  336. text, and initial relief.  The \fBcheckbutton\fR command returns its
  337. \fIpathName\fR argument.  At the time this command is invoked,
  338. there must not exist a window named \fIpathName\fR, but
  339. \fIpathName\fR's parent must exist.
  340. .PP
  341. A check button is a widget
  342. .VS
  343. that displays a textual string or bitmap
  344. and a square called a \fIselector\fR.
  345. A check button has
  346. all of the behavior of a simple button, including the
  347. following: it can display itself in either of three different
  348. ways, according to the \fBstate\fR option;
  349. .VE
  350. it can be made to appear
  351. raised, sunken, or flat; it can be made to flash; and it invokes
  352. a Tcl command whenever mouse button 1 is clicked over the
  353. check button.
  354. .PP
  355. In addition, check buttons can be \fIselected\fR.  If a check button is
  356. selected then a special highlight appears in the selector, and
  357. a Tcl variable associated with the check button is set to a particular
  358. value (normally 1).  If the check button is not selected, then
  359. the selector is drawn in a different fashion and the associated
  360. variable is set to a different value (typically 0).  By default,
  361. the name of the variable associated with a check button is the
  362. same as the \fIname\fR used to create the check button.  The
  363. variable name, and the ``on'' and ``off'' values stored in it,
  364. may be modified with options on the command line or in the option
  365. database.  By default a check button is configured to select and deselect
  366. itself on alternate button clicks.
  367. .VS
  368. In addition, each check button monitors its associated variable and
  369. automatically selects and deselects itself when the variables value
  370. changes to and from the button's ``on'' value.
  371. .VE
  372.  
  373. .SH "WIDGET COMMAND"
  374. .PP
  375. The \fBcheckbutton\fR command creates a new Tcl command whose
  376. name is \fIpathName\fR.  This
  377. command may be used to invoke various
  378. operations on the widget.  It has the following general form:
  379. .DS C
  380. \fIpathName option \fR?\fIarg arg ...\fR?
  381. .DE
  382. \fIOption\fR and the \fIarg\fRs
  383. determine the exact behavior of the command.  The following
  384. commands are possible for check button widgets:
  385. .TP
  386. \fIpathName \fBactivate\fR
  387. Change the check button's state to \fBactive\fR and redisplay the button
  388. using its active foreground and background colors instead of normal
  389. colors.
  390. .VS
  391. This command is ignored if the check button's state is \fBdisabled\fR.
  392. This command is obsolete and will eventually be removed;
  393. use ``\fIpathName \fBconfigure \-state active\fR'' instead.
  394. .VE
  395. .TP
  396. \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
  397. Query or modify the configuration options of the widget.
  398. If no \fIoption\fR is specified, returns a list describing all of
  399. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  400. information on the format of this list).  If \fIoption\fR is specified
  401. with no \fIvalue\fR, then the command returns a list describing the
  402. one named option (this list will be identical to the corresponding
  403. sublist of the value returned if no \fIoption\fR is specified).  If
  404. one or more \fIoption\-value\fR pairs are specified, then the command
  405. modifies the given widget option(s) to have the given value(s);  in
  406. this case the command returns an empty string.
  407. \fIOption\fR may have any of the values accepted by the \fBcheckbutton\fR
  408. command.
  409. .TP
  410. \fIpathName \fBdeactivate\fR
  411. Change the check button's state to \fBnormal\fR and redisplay the button
  412. using its normal foreground and background colors.
  413. .VS
  414. This command is ignored if the check button's state is \fBdisabled\fR.
  415. This command is obsolete and will eventually be removed;
  416. use ``\fIpathName \fBconfigure \-state normal\fR'' instead.
  417. .VE
  418. .TP
  419. \fIpathName \fBdeselect\fR
  420. Deselect the check button:  redisplay it without a highlight in
  421. the selector and set the associated variable to its ``off''
  422. value.
  423. .TP
  424. \fIpathName \fBflash\fR
  425. Flash the check button.  This is accomplished by redisplaying the check button
  426. several times, alternating between active and normal colors.  At
  427. the end of the flash the check button is left in the same normal/active
  428. state as when the command was invoked.
  429. .VS
  430. This command is ignored if the check button's state is \fBdisabled\fR.
  431. .VE
  432. .TP
  433. \fIpathName \fBinvoke\fR
  434. .VS
  435. Does just what would have happened if the user invoked the check button
  436. with the mouse: toggle the selection state of the button and invoke
  437. the Tcl command associated with the check button, if there is one.
  438. The return value is the return value from the Tcl command, or an
  439. empty string if there is no command associated with the check button.
  440. This command is ignored if the check button's state is \fBdisabled\fR.
  441. .VE
  442. .TP
  443. \fIpathName \fBselect\fR
  444. Select the check button:  display it with a highlighted
  445. selector and set the associated variable to its ``on''
  446. value.
  447. .TP
  448. \fIpathName \fBtoggle\fR
  449. Toggle the selection state of the button, redisplaying it and
  450. modifying its associated variable to reflect the new state.
  451.  
  452. .SH BINDINGS
  453. .PP
  454. .VS
  455. Tk automatically creates class bindings for check buttons that give them
  456. the following default behavior:
  457. .IP [1]
  458. The check button activates whenever the mouse passes over it and deactivates
  459. whenever the mouse leaves the check button.
  460. .IP [2]
  461. The check button's relief is changed to sunken whenever mouse button 1 is
  462. pressed over it, and the relief is restored to its original
  463. value when button 1 is later released.
  464. .IP [3]
  465. If mouse button 1 is pressed over the check button and later released over
  466. the check button, the check button is invoked (i.e. its selection
  467. state toggles and the command associated with the button is invoked,
  468. if there is one).  However, if the mouse is not
  469. over the check button when button 1 is released, then no invocation occurs.
  470. .PP
  471. If the check button's state is \fBdisabled\fR then none of the above
  472. actions occur:  the check button is completely non-responsive.
  473. .PP
  474. The behavior of check buttons can be changed by defining new bindings for
  475. individual widgets or by redefining the class bindings.
  476. .VE
  477.  
  478. .SH KEYWORDS
  479. check button, widget
  480.